home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1997 April / macformat-049.iso / mac / Shareware Plus / Developers / dropg++ / usr / include / sys / namei.h < prev    next >
Encoding:
C/C++ Source or Header  |  1997-02-20  |  7.2 KB  |  189 lines  |  [TEXT/R*ch]
  1. /*
  2.  * Copyright (c) 1985, 1989, 1991, 1993
  3.  *    The Regents of the University of California.  All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  * 1. Redistributions of source code must retain the above copyright
  9.  *    notice, this list of conditions and the following disclaimer.
  10.  * 2. Redistributions in binary form must reproduce the above copyright
  11.  *    notice, this list of conditions and the following disclaimer in the
  12.  *    documentation and/or other materials provided with the distribution.
  13.  * 3. All advertising materials mentioning features or use of this software
  14.  *    must display the following acknowledgement:
  15.  *    This product includes software developed by the University of
  16.  *    California, Berkeley and its contributors.
  17.  * 4. Neither the name of the University nor the names of its contributors
  18.  *    may be used to endorse or promote products derived from this software
  19.  *    without specific prior written permission.
  20.  *
  21.  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22.  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24.  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25.  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26.  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27.  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28.  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29.  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30.  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31.  * SUCH DAMAGE.
  32.  *
  33.  *    @(#)namei.h    8.2 (Berkeley) 1/4/94
  34.  */
  35.  
  36. #ifndef _SYS_NAMEI_H_
  37. #define    _SYS_NAMEI_H_
  38.  
  39. /*
  40.  * Encapsulation of namei parameters.
  41.  */
  42. struct nameidata {
  43.     /*
  44.      * Arguments to namei/lookup.
  45.      */
  46.     caddr_t    ni_dirp;        /* pathname pointer */
  47.     enum    uio_seg ni_segflg;    /* location of pathname */
  48.      /* u_long    ni_nameiop;           namei operation */
  49.      /* u_long    ni_flags;           flags to namei */
  50.      /* struct    proc *ni_proc;           process requesting lookup */
  51.     /*
  52.      * Arguments to lookup.
  53.      */
  54.      /* struct    ucred *ni_cred;           credentials */
  55.     struct    vnode *ni_startdir;    /* starting directory */
  56.     struct    vnode *ni_rootdir;    /* logical root directory */
  57.     /*
  58.      * Results: returned from/manipulated by lookup
  59.      */
  60.     struct    vnode *ni_vp;        /* vnode of result */
  61.     struct    vnode *ni_dvp;        /* vnode of intermediate directory */
  62.     /*
  63.      * Shared between namei and lookup/commit routines.
  64.      */
  65.     long    ni_pathlen;        /* remaining chars in path */
  66.     char    *ni_next;        /* next location in pathname */
  67.     u_long    ni_loopcnt;        /* count of symlinks encountered */
  68.     /*
  69.      * Lookup parameters: this structure describes the subset of
  70.      * information from the nameidata structure that is passed
  71.      * through the VOP interface.
  72.      */
  73.     struct componentname {
  74.         /*
  75.          * Arguments to lookup.
  76.          */
  77.         u_long    cn_nameiop;    /* namei operation */
  78.         u_long    cn_flags;    /* flags to namei */
  79.         struct    proc *cn_proc;    /* process requesting lookup */
  80.         struct    ucred *cn_cred;    /* credentials */
  81.         /*
  82.          * Shared between lookup and commit routines.
  83.          */
  84.         char    *cn_pnbuf;    /* pathname buffer */
  85.         char    *cn_nameptr;    /* pointer to looked up name */
  86.         long    cn_namelen;    /* length of looked up component */
  87.         u_long    cn_hash;    /* hash value of looked up name */
  88.         long    cn_consume;    /* chars to consume in lookup() */
  89.     } ni_cnd;
  90. };
  91.  
  92. #ifdef KERNEL
  93. /*
  94.  * namei operations
  95.  */
  96. #define    LOOKUP        0    /* perform name lookup only */
  97. #define    CREATE        1    /* setup for file creation */
  98. #define    DELETE        2    /* setup for file deletion */
  99. #define    RENAME        3    /* setup for file renaming */
  100. #define    OPMASK        3    /* mask for operation */
  101. /*
  102.  * namei operational modifier flags, stored in ni_cnd.flags
  103.  */
  104. #define    LOCKLEAF    0x0004    /* lock inode on return */
  105. #define    LOCKPARENT    0x0008    /* want parent vnode returned locked */
  106. #define    WANTPARENT    0x0010    /* want parent vnode returned unlocked */
  107. #define    NOCACHE        0x0020    /* name must not be left in cache */
  108. #define    FOLLOW        0x0040    /* follow symbolic links */
  109. #define    NOFOLLOW    0x0000    /* do not follow symbolic links (pseudo) */
  110. #define    MODMASK        0x00fc    /* mask of operational modifiers */
  111. /*
  112.  * Namei parameter descriptors.
  113.  *
  114.  * SAVENAME may be set by either the callers of namei or by VOP_LOOKUP.
  115.  * If the caller of namei sets the flag (for example execve wants to
  116.  * know the name of the program that is being executed), then it must
  117.  * free the buffer. If VOP_LOOKUP sets the flag, then the buffer must
  118.  * be freed by either the commit routine or the VOP_ABORT routine.
  119.  * SAVESTART is set only by the callers of namei. It implies SAVENAME
  120.  * plus the addition of saving the parent directory that contains the
  121.  * name in ni_startdir. It allows repeated calls to lookup for the
  122.  * name being sought. The caller is responsible for releasing the
  123.  * buffer and for vrele'ing ni_startdir.
  124.  */
  125. #define    NOCROSSMOUNT    0x00100    /* do not cross mount points */
  126. #define    RDONLY        0x00200    /* lookup with read-only semantics */
  127. #define    HASBUF        0x00400    /* has allocated pathname buffer */
  128. #define    SAVENAME    0x00800    /* save pathanme buffer */
  129. #define    SAVESTART    0x01000    /* save starting directory */
  130. #define ISDOTDOT    0x02000    /* current component name is .. */
  131. #define MAKEENTRY    0x04000    /* entry is to be added to name cache */
  132. #define ISLASTCN    0x08000    /* this is last component of pathname */
  133. #define ISSYMLINK    0x10000    /* symlink needs interpretation */
  134. #define PARAMASK    0xfff00    /* mask of parameter descriptors */
  135. /*
  136.  * Initialization of an nameidata structure.
  137.  */
  138. #define NDINIT(ndp, op, flags, segflg, namep, p) { \
  139.     (ndp)->ni_cnd.cn_nameiop = op; \
  140.     (ndp)->ni_cnd.cn_flags = flags; \
  141.     (ndp)->ni_segflg = segflg; \
  142.     (ndp)->ni_dirp = namep; \
  143.     (ndp)->ni_cnd.cn_proc = p; \
  144. }
  145. #endif
  146.  
  147. /*
  148.  * This structure describes the elements in the cache of recent
  149.  * names looked up by namei. NCHNAMLEN is sized to make structure
  150.  * size a power of two to optimize malloc's. Minimum reasonable
  151.  * size is 15.
  152.  */
  153.  
  154. #define    NCHNAMLEN    31    /* maximum name segment length we bother with */
  155.  
  156. struct    namecache {
  157.     struct    namecache *nc_forw;    /* hash chain */
  158.     struct    namecache **nc_back;    /* hash chain */
  159.     struct    namecache *nc_nxt;    /* LRU chain */
  160.     struct    namecache **nc_prev;    /* LRU chain */
  161.     struct    vnode *nc_dvp;        /* vnode of parent of name */
  162.     u_long    nc_dvpid;        /* capability number of nc_dvp */
  163.     struct    vnode *nc_vp;        /* vnode the name refers to */
  164.     u_long    nc_vpid;        /* capability number of nc_vp */
  165.     char    nc_nlen;        /* length of name */
  166.     char    nc_name[NCHNAMLEN];    /* segment name */
  167. };
  168.  
  169. #ifdef KERNEL
  170. u_long    nextvnodeid;
  171. int    namei __P((struct nameidata *ndp));
  172. int    lookup __P((struct nameidata *ndp));
  173. #endif
  174.  
  175. /*
  176.  * Stats on usefulness of namei caches.
  177.  */
  178. struct    nchstats {
  179.     long    ncs_goodhits;        /* hits that we can really use */
  180.     long    ncs_neghits;        /* negative hits that we can use */
  181.     long    ncs_badhits;        /* hits we must drop */
  182.     long    ncs_falsehits;        /* hits with id mismatch */
  183.     long    ncs_miss;        /* misses */
  184.     long    ncs_long;        /* long names that ignore cache */
  185.     long    ncs_pass2;        /* names found with passes == 2 */
  186.     long    ncs_2passes;        /* number of times we attempt it */
  187. };
  188. #endif /* !_SYS_NAMEI_H_ */
  189.